| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

TextureCopyEffect.h
1 // TextureCopyEffect.h
3 //
5
6 namespace nkAstraeus
7 {
17 class TextureCopyEffect final : public Effect
18 {
19 public :
20
21 // Constructor, destructor
26 TextureCopyEffect (System* system) noexcept ;
31 virtual ~TextureCopyEffect () ;
32
33 // Getters
37 virtual EFFECT_TYPE getType () const override ;
41 nkGraphics::Texture* getSourceTexture () const ;
45 nkGraphics::Sampler* getSourceSampler () const ;
46
47 // Setters
53 void setSourceTexture (nkGraphics::Texture* value) ;
62 void setSourceSampler (nkGraphics::Sampler* value) ;
63
64 // Load
65 virtual bool load () override ;
66 virtual void unload () override ;
67
68 public :
69
70 // Statics
81 static nkMemory::UniquePtr<TextureCopyEffect> create (System* system = nullptr) ;
82 } ;
83 }
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:12
nkAstraeus::EFFECT_TYPE
EFFECT_TYPE
Lists all effects supported.
Definition: EffectType.h:12
nkAstraeus::TextureCopyEffect::TextureCopyEffect
TextureCopyEffect(System *system) noexcept
nkAstraeus::TextureCopyEffect
A texture copy effect.
Definition: TextureCopyEffect.h:18
nkAstraeus::System
The main entry point for nkAstraeus engine.
Definition: System.h:15
nkAstraeus::TextureCopyEffect::~TextureCopyEffect
virtual ~TextureCopyEffect()
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: BlurComplexEffect.h:7
nkMemory::UniquePtr
Smart pointer owning the object instance it encapsulates.
Definition: UniquePtr.h:17
nkAstraeus::Effect
Base class for all effects in the component.
Definition: Effect.h:16
nkGraphics::Sampler
Holds all the information needed of a sampler used during rendering.
Definition: Sampler.h:14
nkAstraeus::TextureCopyEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkAstraeus::TextureCopyEffect::getType
virtual EFFECT_TYPE getType() const override
nkAstraeus::TextureCopyEffect::load
virtual bool load() override
nkAstraeus::TextureCopyEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkAstraeus::TextureCopyEffect::setSourceSampler
void setSourceSampler(nkGraphics::Sampler *value)
nkAstraeus::TextureCopyEffect::getSourceSampler
nkGraphics::Sampler * getSourceSampler() const
nkAstraeus::TextureCopyEffect::unload
virtual void unload() override
nkAstraeus::TextureCopyEffect::create
static nkMemory::UniquePtr< TextureCopyEffect > create(System *system=nullptr)